Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update README (take over #131) #139

Merged
merged 12 commits into from
Oct 12, 2023
Merged

docs: update README (take over #131) #139

merged 12 commits into from
Oct 12, 2023

Conversation

Okabe-Junya
Copy link
Contributor

@Okabe-Junya Okabe-Junya commented Oct 11, 2023 •
edited by zkoppert
Loading

take over #131

Proposed Changes

I have structured the README. Only the essential information is retained in the README, and I've made changes to store each document in the docs directory. This is based on the structure of the CodeQL repository.

(If there are any rules or standards we must adhere to within the GitHub organization, I would like to make further adjustments to comply with them.)

Readiness Checklist

In addition, I made the following changes:

  • Removal of the Table of Contents: GitHub's markdown preview has an automatic table of contents generation feature. It's unlikely we need to maintain this ourselves.
  • Removal of permalinks to each document: Most users should notice that the documents are stored in the docs directory. Managing permalinks can be cumbersome, so I believe it's best to remove them.

Author/Contributor

Note: In this PR, since only documentation updates are being made, I don't anticipate any linting or testing issues to arise.

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing

Reviewer

  • Label as either bug, documentation, enhancement, infrastructure, or breaking

@Okabe-Junya Okabe-Junya marked this pull request as draft October 11, 2023 07:35
@Okabe-Junya
Copy link
Contributor Author

It seems there are still some points that need correction. After making the changes, I will undraft the PR.

Okabe-Junya
Okabe-Junya commented Oct 11, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@Okabe-Junya Okabe-Junya marked this pull request as ready for review October 11, 2023 08:49
@Okabe-Junya Okabe-Junya changed the title update: README (take over #131) docs: update README (take over #131) Oct 11, 2023
zkoppert
zkoppert reviewed Oct 11, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@zkoppert
Copy link
Member

it looks like a few of the docs like the json output, measuring time and others in the docs directory aren't all referenced in the README. I think each doc should at least get a mention in the readme.

@zkoppert zkoppert added the documentation Improvements or additions to documentation label Oct 11, 2023
@Okabe-Junya
Copy link
Contributor Author

Okabe-Junya commented Oct 12, 2023 •
edited
Loading

Thank you for the wonderful review!!

Regarding "I think each doc should at least get a mention in the readme.", are you suggesting adding a section with links to each item as in the following example?

## links

- [Assigning teams instead of individuals](./docs/assign-team-instead-of-individual.md)
- ...

@zkoppert
Copy link
Member

Yes that would be great.

@Okabe-Junya
Copy link
Contributor Author

Okabe-Junya commented Oct 12, 2023 •
edited
Loading

Thank you for the wonderful review!! I made three changes.

  1. reverted the changes to the footnote.
  2. reverted the changes to the example use case.
  3. added a section with links to each document in the README.

zkoppert
zkoppert approved these changes Oct 12, 2023
View reviewed changes
Copy link
Member

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Thank you so much @Okabe-Junya for leading this to completion!! Really appreciate all your contributions to this project! 🎉 🚀

@zkoppert zkoppert merged commit 10ddd24 into github:main Oct 12, 2023
5 checks passed
@spier
Copy link
Contributor

spier commented Oct 12, 2023

@zkoppert looks like merging this has accidentally done some of the changes that we did in #137 prior to this.

@zkoppert zkoppert mentioned this pull request Oct 12, 2023
Merged
4 tasks
@zkoppert
Copy link
Member

@spier Good Catch! I'll get that corrected. #140

@Okabe-Junya Okabe-Junya deleted the junya/update/readme branch October 13, 2023 01:28
This was referenced Oct 14, 2023
Merged
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zkoppert zkoppert zkoppert approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Okabe-Junya @zkoppert @spier @MihirKohli